home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / editors / edith1_0.lzh / EDITH.DOC < prev    next >
Encoding:
Text File  |  1993-04-07  |  44.2 KB  |  1,141 lines

  1.  
  2.                       EDITH- Desktop Text Editress
  3.                          Manual for version 1.0
  4.                              7th April, 1993
  5.  
  6.                       Copyright 1993 ZFC Computing
  7.                            All Rights Reserved
  8.  
  9. ------------------------------------------------------------------------
  10.  
  11. EDITH and this manual were written  by  Annius  Groenink/ZFC  Computing.
  12. EDITH 1.0 IS SHAREWARE!  She   may   be   freely   distributed   through
  13. non-commercial channels. If you decide to use Edith on a regular  basis,
  14. you must pay the shareware fee:
  15.  
  16.    Shareware fee for Edith: DM 25, US$ 15, UKĀ£10, HFL (NLG) 27
  17.    (the fee will be compensated at the purchase of Edith Professional,
  18.     to be presented in August 1993)
  19.  
  20.    made payable to ZFC Computing, Deventer, Netherlands
  21.  
  22.    EuroCheque or similar cheque preferred.
  23.    If this is not possible, transfer the fee to our bank account:
  24.    ABN AMRO Bank (Amsterdam, Netherlands), account no. 44.36.71.672
  25.  
  26.    Our address (mail only)
  27.    Boven Zevenwouden 206
  28.    3524 CK Utrecht
  29.    The Netherlands
  30.    
  31.    e-mail: AVGROENI@CS.RUU.NL
  32.  
  33.  
  34. Edith and this manual are copyright 1993 ZFC  Computing,  Deventer,  the
  35. Netherlands
  36.  
  37. No part of this manual may be reproduced, stored in a retrieval  system,
  38. or transmitted, in any form or by  any  means,  electronic,  mechanical,
  39. photocopying, recording, or otherwise,   without   the   prior   written
  40. permission of the publisher.
  41.  
  42. We make no warranties, either expressed or implied, with respect to this
  43. manual or with respect to the software described  in  this  manual,  its
  44. quality, performance, or fitness for any particular purpose. The  entire
  45. risk as to its quality and performance is with  the  buyer.  Should  the
  46. program prove defective following its purchase, the  buyer  assumes  the
  47. entire cost of all necessary servicing, repair, or  correction  and  any
  48. incidental or consequential damages. In no event will we be  liable  for
  49. direct, indirect or consequential damages resulting from any  defect  in
  50. the software.
  51.  
  52. ------------------------------------------------------------------------
  53.  
  54.  
  55.  
  56. INTRODUCTION
  57.  
  58.    EDITH 1.0 is the shareware prerelease of a commercial  package  we've
  59.    been working on  for  almost  two  years,  which  will  hopefully  be
  60.    presented at the Messe in the fall of 1993. This version doesn't have
  61.    half the amount of features that the commercial 'Edith  Professional'
  62.    will have, but should give you a rough impression of what it is going
  63.    to be like. We  would  appreciate  your  comments,  suggestions,  bug
  64.    reports etcetera. There will be  no  updates  of  this  version.  The
  65.    shareware fee will be compensated when you buy the commercial  'Edith
  66.    Professional' at the end of this year. If you are interested in Edith
  67.    and wish to stimulate further development, DO PAY your shareware  fee
  68.    NOW! We need your support.
  69.  
  70.    A list of features for this version:
  71.  
  72.       - One executable works as application or accessory
  73.  
  74.       - Gemini communications (Transmission  of  keys,  dragging  icons,
  75.          window control) are supported
  76.  
  77.       - All GDOS fonts (including proportional) can be used
  78.  
  79.       - A vertical immediate-reaction-scrollbar   (as   on   most   UNIX
  80.          systems)
  81.  
  82.       - A large scale UNDO function (includes e.g. search and replace)
  83.  
  84.       - Multiple/Square text blocks can be selected and copied
  85.  
  86.       - A double text buffer system (long/short term)
  87.  
  88.       - Key macros
  89.  
  90.       - A simple printer spooler
  91.  
  92.       - Compatible with any machine configuration.
  93.  
  94.  
  95.    Edith Professional will include the following features:
  96.    
  97.       - Elaborate support for Falcon and MultiTOS.
  98.       
  99.       - Full keyboard customisation.
  100.       
  101.       - All text operations like shift left/right  and  text  formatting
  102.          can be confined to multiple selections of any form.
  103.  
  104.       - Binary files can be imported into various hex dump formats.
  105.  
  106.       - Tagged regular expression search AND replace.
  107.  
  108.       - All dialogs in windows. Custom fileselector with file operations
  109.          and full keyboard control.
  110.  
  111.       - Manual window positioning, typed  text  to  background  windows,
  112.          cursor keys on the numeric keypad,  dead  keys  and  more,  all
  113.          configurable.
  114.  
  115.       - A completely revised and unlimited  multiple  selection/multiple
  116.          block editor core.
  117.  
  118.       - Four text block clipboards with automatic routing/archiving.
  119.  
  120.       - A series of standard text editor options not yet provided in 1.0
  121.          such as auto save, save with backup; save files with  Macintosh
  122.          newlines.
  123.  
  124.       - Support for international keyboards (e.g. AZERTY).
  125.  
  126.       - Context sensitive help pages.
  127.  
  128.       - A good manual :)
  129.  
  130.    A demo of Edith Professional is due to  appear  on  the  archives  in
  131.    summer 1993.
  132.  
  133.  
  134.  
  135.  
  136.  
  137. HOW TO INSTALL
  138.  
  139.    Note that the same file  serves  as  EDITH.ACC  and  EDITH.PRG.  Just
  140.    rename the file. For use as a GEM  application,  use  EDITH.PRG,  and
  141.    make sure that the EDITH.RSC and EDITH.CFG are in the same folder. If
  142.    you are using an  alternative  shell,  make  sure  that  the  default
  143.    directory is the one from which EDITH.PRG is started. For  use  as  a
  144.    GEM accessory, put EDITH.ACC, EDITH.RSC and  EDITH.CFG  in  the  root
  145.    directory of your boot disk. For use with Chameleon (as  a  temporary
  146.    desk accessory) select EDITH.ACC or EDITH.PRG from  Chameleon's  file
  147.    selector; make sure the resource files are in the same folder as  the
  148.    executable.
  149.  
  150.  
  151.  
  152.  
  153. STARTING EDITH
  154.  
  155.    - Double click on EDITH.PRG from your desktop. A two- title menu  bar
  156.       will appear, followed by a file selector.
  157.  
  158.    - Start EDITH.PRG with a command line (from  a  command  shell).  The
  159.       command line may consist of
  160.  
  161.          1. A single folder name, ending on '\',  in  which  case  Edith
  162.             opens up with a file selector box set to the given folder
  163.  
  164.          2. A set of files, as many of  which  as  possible  are  loaded
  165.             automatically; no fileselector will appear. Files not  found
  166.             on the disk are opened as new text  files  (See  FILE  MENU,
  167.             OPEN FILE).
  168.  
  169.    - Use EDITH.ACC as a desk accessory. The program will remain resident
  170.       until the user opens the accessory.
  171.  
  172.  
  173. OPENING A TEXT
  174.  
  175.    Open a text window using  the  desktop  menu  bar  (Open...)  or  the
  176.    open- icon on the desktop. In  the  accessory  version,  clicking  on
  177.    'Edith' in the 'Desk'- menu gives you a  four-  icon  control  window
  178.    that includes  a   'Open   text'   icon.   Alternatively,   in   both
  179.    versions, press Control O.
  180.  
  181.    A file selector box will show up. Now either select an existing file,
  182.    or type a non- existing file name. In case of a new name, Edith  will
  183.    ask for the initial amount of memory to be  allocated  for  the  text
  184.    (preset to a comfortable value). Then, a window  is  opened,  showing
  185.    the new text.
  186.  
  187.    When Edith is installed as an accessory, there is a way to load texts
  188.    from a shell: the program 'OPEN.TTP' is a tiny program that sends  an
  189.    AES message to Edith. Synopsis is as you expect it to be:
  190.  
  191.       OPEN <files>.
  192.  
  193.    The text will be opened as soon as  Edith  gets  the  message.  (This
  194.    depends on whether your shell is an accessory, the Mupfel console  or
  195.    a regular TOS program that has to terminate first).
  196.  
  197.    NOTE
  198.  
  199.       1. OPEN.TTP uses the cookie jar to create a  command  line  buffer
  200.          only the first time it is run. If there is no jar, it will  NOT
  201.          install a new jar, and therefore every time you  use  OPEN.TTP,
  202.          it will consume memory (I guess some 10K). I suggest you use an
  203.          auto folder program that installs  a  cookie  jar  with  system
  204.          cookies.
  205.  
  206.       2. More possibilities are given in section GEMINI.
  207.  
  208.       3. Remember that accessories only react to  keyboard  commands  if
  209.          one of their windows is on top.
  210.  
  211.  
  212. TEXT WINDOWS
  213.  
  214.    Edith's  windows  look  rather  different  then  in  most  other  GEM
  215.    programs. A number of 'weird' window attributes is provided:-
  216.  
  217.       - a MENU BAR (See next section)
  218.  
  219.       - a TEXT INFORMATIONS DISPLAY showing
  220.  
  221.          1. The TEXT STATUS: a TICK SIGN means that the  text  has  been
  222.             changed (i.e. the one on filestore is different). A QUESTION
  223.             MARK indicates that the text has been changed,  but  can  be
  224.             restored in its original form by pressing the  UNDO  button,
  225.             or by user  correction  (which  Edith  will  notice).  An  X
  226.             (cross) is displayed if Edith is out of memory for the  text
  227.             window. Several text functions are then disabled (See  ALERT
  228.             MESSAGES)
  229.  
  230.          2. The percentage of available memory for this text window that
  231.             is currently occupied. If 100% is exceeded, Edith  will  try
  232.             to reallocate the text, augmenting the  available  space  by
  233.             the value specified in the MEMORY dialog  box  (See  'EDITH'
  234.             MENU, MEMORY...)
  235.  
  236.          3. The current cursor line number.
  237.  
  238.       - a RULER showing the text columns (roughly, when in  proportional
  239.          display mode) and tabulator positions. Tabstops can be set  and
  240.          removed using the left mouse button. Minimum  tab  distance  is
  241.          two horizontal cells. A thicker bar indicates  the  right  text
  242.          margin, which can be placed using the right mouse button.
  243.  
  244.       - a VERTICAL SCROLL BAR, working rather different than usual  (but
  245.          similar to the ones used in GEMINI dialog boxes):
  246.  
  247.             LEFT button on slider:
  248.  
  249.                Mouse 'grabs' the slider and allows you to wander through
  250.                the text. Alternatively, in  the  DISPLAY  dialog  (EDITH
  251.                menu, Display) you can select the 'traditional' mode.
  252.  
  253.             LEFT button on background:
  254.  
  255.                Page up/down.
  256.  
  257.             RIGHT button on slider:
  258.  
  259.                Scrolls through the text where  the  number  of  scrolled
  260.                lines is proportional to the number of  pixels  you  move
  261.                the mouse.
  262.  
  263.             RIGHT button on background:
  264.  
  265.                The slider 'jumps' to where you clicked.
  266.  
  267.       - ARROWS and SIZER- work similar to the usual system.
  268.  
  269.    Also, the window closer and fuller work different  than  usual.  When
  270.    you click on the  closer  or  the  fuller,  a  small  menu  pops  up,
  271.    containing window functions. Special   here   are   'Gather',   which
  272.    shuffles all windows under the top one, and 'Iconize', which  removes
  273.    the full window, and places its name in the lower right corner of the
  274.    screen. (See KEYBOARD CONTROL, Control U, Alternate F,  Alternate  W,
  275.    Alternate I).
  276.  
  277.  
  278. REMARKS
  279.  
  280.    ACCESSORY VERSION. When a GEM application is started or left, all GEM
  281.       windows are closed. Edith then goes into 'silent mode'. The  first
  282.       time you open Edith (usually through the Desk menu), it will first
  283.       re- open all the current texts in memory.
  284.       
  285.       TECHNICAL NOTE. Edith changes the active process  descriptor  when
  286.          allocating memory to ensure that memory allocated by the  Edith
  287.          accessory  will  not  get  lost  when  applications  are  left.
  288.          Although this method was never documented by Atari, it works on
  289.          all single tasking TOSes and under MultiTOS the problem  is  no
  290.          more relevant.
  291.  
  292.  
  293.    BREAK FUNCTION. Throughout the program, the combination
  294.  
  295.          Alternate + LeftShift + Control
  296.  
  297.       breaks long processes (e.g. loading series of files, dumping  text
  298.       fragments, text manipulations, key macro output). When  the  break
  299.       function is available, the busy bee will change into a picture  of
  300.       the atari keyboard with the break  combination  pressed.  (Oh,  is
  301.       THAT what it's supposed to look like! :)
  302.  
  303.  
  304. TYPING TEXT
  305.  
  306.    Text can be typed in the text field of the top window. Text is either
  307.    inserted (cursor has an 'I'- form) or overwritten (cursor is a  solid
  308.    square). Keys  for  basic  text  editing  are,  with  comments  where
  309.    necessary:-
  310.  
  311.       - Small and capital letters, digits, standard ascii symbols
  312.  
  313.       - RETURN
  314.  
  315.       - SHIFT RETURN                      Gives a single CR-  character,
  316.                                           not a newline
  317.  
  318.       - SPACE
  319.  
  320.       - ARROW KEYS
  321.  
  322.       - SHIFT ARROW LEFT, RIGHT           Goto begin, end of line
  323.  
  324.       - CONTROL ARROW LEFT, RIGHT         One word left, right
  325.  
  326.       - SHIFT ARROW UP, DOWN              Goto top/bottom line of window.
  327.  
  328.       - CONTROL ARROW UP, DOWN            Page up, down
  329.  
  330.       - TAB                               Tab, spaces or a clock symbol,
  331.                                           dependent of  parameters  (See
  332.                                           'TEXT'       MENU,        TEXT
  333.                                           PARAMETERS...)
  334.  
  335.       - HOME                              Go to upper end of text (after
  336.                                           saving the  text  position  on
  337.                                           the position stack, See 'EDIT'
  338.                                           MENU, PUSH POSITION)
  339.  
  340.       - SHIFT HOME                        Go to lower end of text (after
  341.                                           saving the text position)
  342.  
  343.       - BACKSPACE                         Delete a character,  backward.
  344.                                           Does NOT delete newlines.
  345.  
  346.       - SHIFT BACKSPACE                   As backspace,  but DOES delete
  347.                                           newlines.
  348.  
  349.       - DELETE                            Delete the character right  to
  350.                                           (or under)  the  cursor.  Does
  351.                                           NOT delete newlines.
  352.  
  353.       - SHIFT DELETE                      As Delete,  but  also  deletes
  354.                                           newlines.
  355.  
  356.       - INSERT (overwrite mode only)      Insert a blank.
  357.  
  358.       - SHIFT INSERT                      Insert a newline.
  359.  
  360.  
  361. THE TEXT SELECTION SYSTEM
  362.  
  363.    Each text window has its own SELECTION: a  (possibly  empty)  set  of
  364.    marked contiguous text fragments. These fragments are inverted (white
  365.    on black) in text windows. When pieces  of  text  are  selected,  the
  366.    text cursor stops blinking.
  367.  
  368.    Common for all texts is the   TEXT   BUFFER,   which   is   held   in
  369.    independent, shared memory. A seperate LONG TERM TEXT BUFFER is  also
  370.    provided,  but  will  be  discussed  later  (See  'EDIT'  MENU,  SWAP
  371.    BUFFERS).
  372.  
  373.    Text fragments can be selected using the mouse:
  374.  
  375.       LEFT button: As usual- a contiguous text block is marked. You  can
  376.                      move up- as well as downwards.
  377.  
  378.       RIGHT button: A rubberbox encloses a square area  of  text,  which
  379.                      will result in a   selection   of   multiple   text
  380.                      fragments. (One for each line)
  381.  
  382.    Both processes,  when  carried  out  with  SHIFT  pressed,  ADD  text
  383.    fragments to the existing selection.
  384.  
  385.    Alternatively, a single fragment can be selected using  F1  (fragment
  386.    start) and F2 (fragment end) keys.
  387.  
  388.    NOTE
  389.  
  390.       1. The total number of selected fragments per text is bounded.
  391.  
  392.       2. The cursor stops blinking when text parts are marked.  This  is
  393.          an essentially different situation than in Macintosh- like text
  394.          editors,  which  usually  REPLACE  the  cursor  by  ONE  BLOCK.
  395.          (Technically, the normal (mac!)  cursor  is  a  block  of  zero
  396.          width). Instead, Edith allows you to walk through the text even
  397.          if there are selected text fragments.
  398.  
  399.    The selected text parts can be manipulated by  functions  like  COPY,
  400.    CUT, PASTE, etc. (See  'EDIT'  MENU).  Alternave  ways  of  making  a
  401.    selection are given in the KEYBOARD CONTROL and 'EDIT' MENU sections.
  402.  
  403.    The selection is cleared automatically by any subsequent text  action
  404.    other than cursor movement. Selection AND buffer can  be  cleared  by
  405.    Clear Buffer (Alternate E, F10) in the Edit menu.
  406.  
  407.  
  408. THE CONTROL WINDOW (ACC VERSION ONLY)
  409.  
  410.    The accessory version has a control  window  (similar  to  the  Atari
  411.    Control Panel) with icons  for   Information,   Open   text,   Memory
  412.    organisation and Save Configuration. The 'Edith Eye' can  be  removed
  413.    using the window fuller, in order to win space on  your  screen.  The
  414.    size and position of the   control   window   are   stored   in   the
  415.    configuration file.
  416.  
  417.    NOTE By DOUBLE clicking on the  control  icons  the  icon  window  is
  418.       removed before executing the appropriate control function.
  419.  
  420.  
  421. THE (WINDOW) MENU BAR
  422.  
  423.    Each Edith window has a menu bar of its own.  Note  that  these  menu
  424.    bars do NOT work the same as the usual desktop  menu  bar,  but  more
  425.    like the one used in the macintosh operating system: a menu will only
  426.    drop down when you click on it.
  427.  
  428.    When run as an application, Edith also has a regular menu  bar,  that
  429.    contains entries which can also be found  in  the  individual  window
  430.    menus. It will not be discussed seperately.
  431.  
  432.  
  433. THE 'EDITH' MENU
  434.  
  435.    (Information and special features)
  436.  
  437.       (ABOUT GROUP)
  438.  
  439.       About Edith... (Control A)
  440.  
  441.          Provides brief information  about  the  particular  version  of
  442.          Edith that you are using.
  443.  
  444.       (CONFIGURATION GROUP)
  445.  
  446.       Memory...
  447.  
  448.          The memory dialog box
  449.  
  450.          -  Shows the amount of memory currently allocated  IN  ADDITION
  451.             TO the  minimum  amount  (program,  resource,  buffers,  key
  452.             macros), that is,  text  memory,  text  buffers  and  memory
  453.             allocated by the printer spooler.
  454.  
  455.          and provides controls:
  456.  
  457.          -  An amount 'Leave ....K' of memory which Edith has  to  leave
  458.             free under ANY condition.
  459.  
  460.          -  A percentage 'Overallocate ...%': When  a  text  is  loaded,
  461.             Edith  will  allocate  the  specified  percentage  of  extra
  462.             memory. This allows  the  text  to  grow,  without  frequent
  463.             re-allocation (See ALERT MESSAGES, RE- ORGANISING MEMORY).
  464.  
  465.          -  'Clear Buffers' clears the two text buffers.
  466.  
  467.       Save Configuration
  468.  
  469.          -  Saves the configuration file 'EDITH.CFG'.
  470.  
  471.       (SPECIAL FEATURES GROUP)
  472.  
  473.       Key Macros...
  474.  
  475.          The key macro dialog box consists of
  476.  
  477.          -  A 'defined key' display with two arrow  buttons:  using  the
  478.             arrows one can   walk   through   previously   defined   key
  479.             combinations.
  480.  
  481.          and actions
  482.  
  483.          -  New Key: A message pops up, telling you  to  press  the  key
  484.             combination you wish to redefine. The escape key cancels the
  485.             operation. After fetching the key  combination,  Edith  will
  486.             come up with a second message, telling you to type  the  key
  487.             sequence which is   to   be   assigned   to   the   selected
  488.             combination. The escape key ends the sequence.
  489.  
  490.             While typing  the  replacement  key  sequence  you  can  use
  491.             Alternate + Numerical pad numbers (press  return  after)  to
  492.             insert non- standard ascii characters.
  493.  
  494.          -  Record: The previously recorded key combination shown in the
  495.             defined key display will be re-recorded, as described  under
  496.             'New Key'.
  497.  
  498.          -  Erase Key: Removes a key combination and its substitute from
  499.             the macro list.
  500.  
  501.          PREDEFINED KEY MACROS
  502.  
  503.             The supplied EDITH.CFG file contains a number of example key
  504.             macros:
  505.  
  506.             Alternate Tab:                Shift LeftArrow
  507.                                           Tab
  508.                                           Shift LeftArrow
  509.                Inserts a tab
  510.  
  511.             Control LeftShift UpArrow:    79xUpArrow
  512.                79 lines up
  513.  
  514.             Control LeftShift DownArrow:  79xDownArrow
  515.                79 lines down
  516.  
  517.             Alternate Backspace:          F8, Shift Insert
  518.                Clear line
  519.  
  520.             '*' on numerical pad          Bullet + space ('item' sign)
  521.  
  522.  
  523.       Display...
  524.  
  525.          This dialog handles fonts and scrollbars.
  526.  
  527.          The 'Font' box lets you  scroll  through  the  available  fonts
  528.          (just one if you do don't have a resident GDOS), and select one
  529.          by clicking on its name. The 'Size' box does the same with  the
  530.          available sizes for  the  currently  selected  font.  When  you
  531.          switch fonts, the closest available size will be  selected.  In
  532.          the 'Face' box, a short string indicates the result.
  533.  
  534.          The 'scrollbar' radio buttons let you set  the  appearance  and
  535.          action of the window and dialog scrollbars to your preference.
  536.  
  537.       Special Characters... (Alternate S)
  538.  
  539.          A box with 160 character buttons and a cancel option-  clicking
  540.          on one of the special characters inserts that character in  the
  541.          text. Reference (ASCII) numbers are shown, as  a  lookup  table
  542.          for use with the 'Alternative' method  for  special  characters
  543.          (See KEYBOARD CONTROL).
  544.  
  545.       (PRINTER GROUP)
  546.  
  547.       Print...
  548.  
  549.          The Print dialog box. The selection or the whole  text  can  be
  550.          printed. (If the whole text  is  printed,  a  'Select  All'  is
  551.          performed.) One- and twocolumn printout are  supported.  Number
  552.          of horizontal  and  vertical  cells  on  your  printer  can  be
  553.          specified (and this is strictly necessary if you are using  the
  554.          two column mode!). The printed  part  is  kept  in  a  strictly
  555.          private buffer. (I.e. there is no  danger  in  continuing  your
  556.          work while the spooler is printing.)
  557.  
  558.          While one  column  output  literally  dumps  the  text  to  the
  559.          printer, two column output uses form feeds between a  specified
  560.          number of lines. Printing ALSO STARTS with a form feed.
  561.  
  562.          Only one text at a time can be printed. If the last  print  job
  563.          is not yet finished, an alert message will ask whether the  old
  564.          job has to be aborted.
  565.  
  566.          HINTS:
  567.  
  568.             - For two column output, do not forget to select a condensed
  569.                printer font.
  570.  
  571.             - Confer your printer manual for the  number  of  horizontal
  572.                cells; generally, 66 lines or less per page is safe.
  573.  
  574.             - Most printers have the tab size set to 8. If you  want  to
  575.                keep your own format, you will have to perform an 'expand
  576.                tabs' (See 'TEXT' MENU) before you start printing.
  577.  
  578.       Abort Printing
  579.  
  580.          After your confirmation, the printer output is aborted.
  581.  
  582.  
  583. THE 'FILE' MENU
  584.  
  585.    Open/close texts, Communication with filestore.
  586.  
  587.       (LOAD GROUP)
  588.  
  589.       Open... (Control O)
  590.  
  591.          Described in OPENING A TEXT.
  592.  
  593.       Restore
  594.  
  595.          Retrieves the current text as  last  saved/loaded,  after  your
  596.          confirmation.
  597.  
  598.       Insert...
  599.  
  600.          Select a text file to insert into your text. The file  will  be
  601.          loaded into the text block  buffer.  (See  THE  TEXT  SELECTION
  602.          SYSTEM)
  603.  
  604.       (SAVE GROUP)
  605.  
  606.       Save (Control S)
  607.  
  608.          Save the text under its current name. The status  of  the  text
  609.          will be set to 'Unchanged'.
  610.  
  611.       Save as...
  612.  
  613.          Save the text under a different  name  (File  Selector).  After
  614.          saving the text, Edith gives the choice to take the old or  the
  615.          new name as default.
  616.  
  617.       Save All
  618.  
  619.          Save all open files. This is useful when Edith is in use as  an
  620.          accessory, since then there  is   no   'Quit'   function   that
  621.          automatically saves all files.
  622.  
  623.       Save Buffer...
  624.  
  625.          Save the block buffer  to  a  file.  (See  THE  TEXT  SELECTION
  626.          SYSTEM)
  627.  
  628.       (WINDOW GROUP- more elaborated in the desktop menu bar)
  629.  
  630.       Close (Control U)
  631.  
  632.          Identical to the window closer. If the text has  been  changed,
  633.          an alert box will come up offering SAVE, SAVE AS, ABANDON,  and
  634.          CANCEL.
  635.  
  636.       Close All
  637.  
  638.          Closes all  windows.  This  is  an  alternative  for  the  QUIT
  639.          function  that  is  only  available  if  Edith  is  run  as  an
  640.          application.
  641.  
  642.  
  643. THE 'EDIT' MENU Basic text edit tools:
  644.  
  645.       (ACTION GROUP, See THE TEXT SELECTION SYSTEM)
  646.  
  647.       Cut (Control X, Delete)
  648.  
  649.          Remove the selected text fragments. The text block is stored in
  650.          the block buffer.
  651.  
  652.       Copy (Control C)
  653.  
  654.          Copy the selected fragments into the block buffer.
  655.  
  656.       Paste (Control V, Insert)
  657.  
  658.          Insert the contents of the block buffer into the text,  as  one
  659.          contiguous fragment. The inserted fragment will be marked.  For
  660.          the UNDO function to  work,  this  selection  has  to  be  kept
  661.          unchanged.
  662.  
  663.       Dump (Control D)
  664.  
  665.          Insert the contents of the block buffer into the text, but  one
  666.          line at a time, left aligned.  Example  of  an  application  is
  667.          putting two text columns next to eachother.
  668.  
  669.       (SELECTION/BUFFER GROUP, See THE TEXT SELECTION SYSTEM)
  670.  
  671.       Select All (Control N)
  672.  
  673.          Selects the entire text, as one contiguous fragment.
  674.  
  675.       Invert Selection (Control I)
  676.  
  677.          Inverts the selection (exactly the text  parts  that  were  not
  678.          marked become marked.) Has the same effect as  Select  All,  if
  679.          there is no present selection.
  680.  
  681.       Clear Selection (Alternate E, F10)
  682.  
  683.          The  selection  and  position  stack  are  cleared.  (See  PUSH
  684.          POSITION)
  685.  
  686.       Swap buffers (Alternate B)
  687.  
  688.          A second deep buried text  buffer  is  provided,  and  is  only
  689.          accessible by this function, that exchanges the foreground  and
  690.          background buffers. The deep  buffer  can  be  cleared  in  the
  691.          memory dialog. (See 'EDITH' MENU, MEMORY)
  692.  
  693.       (POSITION GROUP)
  694.  
  695.       Push Position (Alternate P, F9)
  696.  
  697.          Push the text position on the  position  stack.  The  positions
  698.          saved on the stack are displayed on the  scroll  bar  as  black
  699.          strokes.
  700.  
  701.       Pop Position (Control P, Shift F9)
  702.  
  703.          Retrieve the last pushed text position. The stack is  circular,
  704.          that is, popped positions are not erased. To  clear  the  stack
  705.          use Alternate E or F10. ('EDIT' MENU, Clear Selection).
  706.  
  707.  
  708. THE 'TEXT' MENU Text parameters and manipulation.
  709.  
  710.       (SEARCH GROUP)
  711.  
  712.       Search... (Control F, Control R)
  713.  
  714.          The search/search and replace operations share  a  dialog  box.
  715.          The box contains a switch to  choose  between  the  operations;
  716.          Control F comes up in search mode, Control R comes up in search
  717.          and replace mode.
  718.  
  719.          Many variants of search/replace actions are supported:
  720.  
  721.             - search once: search is either up or down;  if  nothing  is
  722.                found, search direction is automatically reversed
  723.  
  724.             - search all: all occurences of the target string are marked
  725.                (selected), provided that there are less than the maximum
  726.                number  of    selection    fragments    (See    NUMERICAL
  727.                SPECIFICATIONS)
  728.  
  729.             - replace once: as search once
  730.  
  731.             - replace some: for every target  found  you  are  asked  to
  732.                confirm replacement
  733.  
  734.             - replace all: all occurences of the target string are
  735.                replaced. All replaced strings are marked, if possible.
  736.  
  737.          Any search type can begin at the cursor, or  the  beginning  of
  738.          the text. A switch for case sensitivity is also  provided.  For
  739.          both the target and replacement string two lines are  provided,
  740.          which will be concatenated (so there is no need to fill  up  de
  741.          first line entirely before using the second).
  742.  
  743.          A switch is also provided for non- case sensitive search.  NOTE
  744.          that only case sensitive search actions can be undone. (This is
  745.          subject to changes in later versions.)
  746.  
  747.       Search next (Control G, Control T)
  748.  
  749.          Repeats the last  search/replace  operation.  This  only  makes
  750.          sense in the search/replace once case. Note that  although  the
  751.          menu entry repeats the last action, control G forces  a  SEARCH
  752.          and control T forces a REPLACE action. This makes weird  things
  753.          like 'search first replace next' possible.
  754.  
  755.       (MANIPULATION GROUP)
  756.  
  757.       Shift Left
  758.  
  759.          Moves the text lines that are fully covered  by  the  selection
  760.          one tabstop left, where possible.
  761.  
  762.       Shift Right
  763.  
  764.          Moves the text lines that are fully covered  by  the  selection
  765.          one tabstop right.
  766.  
  767.       Expand Tabs
  768.  
  769.          Replaces all occurring tab characters (ASCII 9) in the selected
  770.          text lines by sequences of spaces (according to the  tab  stops
  771.          as set in the ruler).
  772.  
  773.       Compress Tabs (Economize)
  774.  
  775.          Replaces   sequences   of   two   or   more   spaces   by   tab
  776.          characters, where possible. With a  monospaced  font  and  tabs
  777.          displayed as white space, there is no visual effect.
  778.  
  779.          In addition, any tab or space characters at the end of  a  line
  780.          will be removed. This gives the operation an 'economy' flavour.
  781.  
  782.          Compress Tabs either works  on  whole  lines  or  just  on  the
  783.          indentation of each line. This is set in the 'Text  Parameters'
  784.          dialog; by setting 'Indentation Only'  you  prevent  inter-word
  785.          space characters from being transformed into  tabs,  which  has
  786.          unpleasant consequences for formatted text.
  787.  
  788.       Cut/Wrap Lines...
  789.  
  790.          Brings up the 'CHANGE  LINE  LENGTH'  dialog.  You  can  choose
  791.          between wrapping the lines and cutting them off, both at  given
  792.          maximal column. The main purpose of this feature is  is  to  be
  793.          able to examine binarish files.
  794.  
  795.  
  796.       (PARAMETER GROUP)
  797.  
  798.       Text Parameters...
  799.  
  800.          The TEXT PARAMETERS dialog concerns text conventions. Switches:
  801.  
  802.             - Display tabs  as  SPACES  or  CLOCKS  (a  'clock'  is  the
  803.                character symbol an ST writes for ASCII 9, or TAB).
  804.  
  805.             - Generate TABS or SPACES when the tab key is pressed.
  806.  
  807.             - Set the tab length. A tab length  can  be  entered,  which
  808.                will be set only if the box on the left is ticked.
  809.  
  810.                REMARK since irregular tab distributions are just as well
  811.                   possible,  the  'tab  size'  is  not  at  all  a  real
  812.                   parameter of the text. Thus, all the tab stops, rather
  813.                   then a tab size are saved to the parameter file.
  814.  
  815.             - Auto indent on/off. If in on position, at  each  new  line
  816.                (return key) Edith copies the part of the  previous  line
  817.                that begins with spaces or tabs. This is a useful feature
  818.                for programmers.
  819.  
  820.             - Set the file save format. This can be set  to  UNIX  (line
  821.                ends with a single ASCII 10, newline character) or  MSDOS
  822.                (line ends with a CR/LF, ASCII 13 then 10).  TOS  follows
  823.                the MSDOS convention.
  824.  
  825.             - Automatic wordbreak on/off. This is also done by  the  F5-
  826.                key. If the autobreak function is on, Edith will  correct
  827.                the text you type, whenever by  your  text  insertions  a
  828.                line exceeds the right margin.
  829.  
  830.             - Right align on/off. If on, the wordbreak function  inserts
  831.                spaces in your text in order to neatly align your text to
  832.                the right margin.
  833.  
  834.             - Mode setting for Compress Tabs. (See TEXT  menu,  Compress
  835.                Tabs).
  836.  
  837.       Format Paragraph (Control B, F4)
  838.  
  839.          Manual  text  formatting.  More  powerful  than  the  automatic
  840.          wordbreak, this function normally formats one  paragraph,  that
  841.          is from the cursor until an empty line or the end of the  text.
  842.          If you want to format more than that, or  limited  text  parts,
  843.          you can select the text parts to be formatted and then use this
  844.          function.
  845.             You will have some  trouble  if  you  link  your  paragraphs
  846.          without blank lines (using an indentation.) In that  case,  you
  847.          will have to select each of your  paragraphs  together  into  a
  848.          multiple selection  and   then   use   the   Format   Paragraph
  849.          function. This will then work correctly.
  850.  
  851.          NOTE Edith respects existing text indentations where  possible.
  852.             Whenever a TAB character appears on a line, everything  left
  853.             of  this  character  remains  unaffected  by  the  wordbreak
  854.             function. This is to achieve  a  reasonable  performance  on
  855.             two- column text diagrams (an  example  of  which  you  will
  856.             find, for example, in the chapter KEYBOARD CONTROL).
  857.  
  858.       Insert
  859.  
  860.          When INSERT is ticked, typed text will be inserted in the text.
  861.  
  862.       Overwrite
  863.  
  864.          When OVERWRITE is ticked, typed text will be written  over  the
  865.          old text. (Except at the end of lines.) The insert key abandons
  866.          its function of 'PASTE' (See 'EDIT' MENU, PASTE) which is still
  867.          covered by Control V. Instead, it  INSERTS  a  space  into  the
  868.          text.
  869.  
  870.          Overwrite mode can only be used with monospaced fonts.
  871.  
  872.  
  873. KEYBOARD CONTROL
  874.  
  875.    A wide range of key functions is provided. Some of the key  codes  do
  876.    not appear in the drop down menus. Note that Edith keycodes  work  if
  877.    an Edith window is on top.  Just  as  well,  the  main  application's
  878.    keycodes do NOT work when an Edith window is on top, unless the  main
  879.    application provides message passing services (See GEMINI)
  880.  
  881.    Each key is listed, together with key and menu alternatives.
  882.  
  883.    ')','}',']'       Close bracket and search  opening  bracket.  For  a
  884.                      short while,  the  cursor  will  mark  the  opening
  885.                      bracket,  or  the  point  where  the  brackets  are
  886.                      inconsistent. In the latter case  Edith  will  also
  887.                      give a bell sound. (As is often  set  in  the  UNIX
  888.                      editor VI.)
  889.  
  890.    Alternate Numpad [0-9]
  891.  
  892.                      As  on  PC  keyboards,  you  can  enter  a  special
  893.                      character by its  ascii   code.   Hold   down   the
  894.                      Alternate key, type the decimal ascii code  of  the
  895.                      character, and release Alternate.
  896.  
  897.    Shift 'Numpad ('  Search the left enclosing parenthesis '(','{','['.
  898.  
  899.    Shift 'Numpad )'  Search the right enclosing parenthesis ')','}',']'.
  900.  
  901.    Control A         About Edith, EDITH and desktop DESK menus.
  902.  
  903.    Control C         Copy selection, EDIT menu.
  904.  
  905.    Control D         Dump selection, EDIT menu.
  906.  
  907.    Control F         Search..., TEXT menu.
  908.  
  909.    Control G         Search next, TEXT menu.
  910.  
  911.    Control I         Invert selection, EDIT menu.
  912.  
  913.    Control J         Join two text lines. One space  character  will  be
  914.                      added between the two  lines.  Any  spaces  on  the
  915.                      beginning of the linked next line will be removed.
  916.  
  917.    Control L         Goto line. Enter line number in dialog box. Current
  918.                      position is saved on position stack.
  919.  
  920.    Control N         Select all, EDIT menu.
  921.  
  922.    Control O         Open new text, FILE and desktop FILE menus.
  923.  
  924.    Control P         Pop text position, EDIT menu, F9 key.
  925.  
  926.    Control Q         Quit, desktop FILE menu. Closes  all  texts  first.
  927.                      Only works when Edith is used as application.
  928.  
  929.    Control R         Search and replace, TEXT menu.
  930.  
  931.    Control S         Save text, FILE menu.
  932.  
  933.    Control T         Replace next, TEXT menu.
  934.  
  935.    Control U         Close window. If changed since load or last save, a
  936.                      confirmation alert box pops up.
  937.  
  938.    Control V         Paste, EDIT menu.
  939.  
  940.    Control W         Shuffle windows, desktop FILE menu.
  941.  
  942.    Control X         Cut, EDIT menu.
  943.  
  944.    Control Y/Z       Delete line, F8 key.
  945.  
  946.    Alternate B       Swap blocks, EDIT menu.
  947.  
  948.    Alternate D       Delete lines. Enter number of lines to delete  (and
  949.                      copy into buffer) in the dialog box.
  950.  
  951.    Alternate E       Clear selection, buffer and  position  stack,  EDIT
  952.                      menu.
  953.  
  954.    Alternate F       Full top window, desktop FILE menu.
  955.  
  956.    Alternate P       Push text position, EDIT menu, Shift F9.
  957.  
  958.    Alternate S       Special characters, EDITH menu, F6 key.
  959.  
  960.    Alternate I       Iconize top window. This means that the  window  is
  961.                      put in the lower right corner of the screen,  at  a
  962.                      minimum size  (that  is,  only  the  mover  bar  is
  963.                      visible). It still consumes one  AES  window  slot.
  964.                      Clicking anywhere on an iconized window opens it.
  965.  
  966.    Alternate W       Gather windows, desktop  FILE  menu.  Shuffles  all
  967.                      Edith windows under the  current  top  window.  The
  968.                      windows get smaller.
  969.  
  970.    Alternate Y/Z     Copy lines. A dialog box lets you enter a number of
  971.                      lines which will be selected and copied.
  972.  
  973.    F1                Block start. Generates a single fragment  selection
  974.                      starting  at the present cursor position.
  975.  
  976.    F2                Block end. Generates a  single  fragment  selection
  977.                      ending  at the present cursor position.
  978.  
  979.    F3                Auto indent On/Off
  980.  
  981.    F4                Format Paragraph, TEXT menu, Control B.
  982.  
  983.    F5                Auto Wordbreak On/Off
  984.  
  985.    F6                Special characters, EDITH menu, Alternate S.
  986.  
  987.    F7                Search again, TEXT menu, Control G.
  988.  
  989.    F8                Delete line.
  990.  
  991.    F9                Pop text position, EDIT menu, Control P.
  992.  
  993.    Shift F9          Push text position, EDIT menu, Alternate P.
  994.  
  995.    F10               Clear selection, block  and  position  stack,  EDIT
  996.                      menu, Alternate E.
  997.  
  998.    HELP              Shows key combinations that are not in the menus.
  999.  
  1000.    UNDO              Undo the last action, if sensible.  (See  THE  UNDO
  1001.                      FUNCTION)
  1002.  
  1003.  
  1004. THE UNDO FUNCTION
  1005.  
  1006.    This is one of the powerful features of Edith. Undo is  provided  for
  1007.    the following text actions:
  1008.  
  1009.       ACTION               REMARKS
  1010.  
  1011.       Typing text          On one line; the whole line is restored.
  1012.  
  1013.       Newline              Not if an indentation is generated
  1014.  
  1015.       Delete newline
  1016.  
  1017.       Cut selection        Unless a not left aligned multiple block  was
  1018.                            deleted.
  1019.  
  1020.       Paste block
  1021.  
  1022.       Dump block
  1023.  
  1024.       Delete line          As a special case of 'Cut selection'.
  1025.  
  1026.       Search and Replace   Only in case sensitive mode.
  1027.  
  1028.    Some of the UNDO actions depend on the text selection or text buffer;
  1029.    if you change the selection or buffer  contents  UNDO  will  in  some
  1030.    cases be impossible.
  1031.  
  1032.    Edith remembers whether the changes you  are  making  are  the  first
  1033.    changes to the text. If so, the UNDO function will  also  change  the
  1034.    text status back to 'Unchanged', which is visible in the upper  right
  1035.    corner of the text window (See TEXT WINDOWS). Also, Edith  recognizes
  1036.    reverse actions, i.e. if you load a text, change a  line,  change  it
  1037.    back manually, and then close the window, it  will  recognize  it  as
  1038.    unchanged and close the window without any further questions.
  1039.  
  1040.  
  1041. CREATIVE SUGGESTIONS
  1042.  
  1043.    Things to keep in mind are
  1044.  
  1045.       SQUARE TEXT BLOCKS. Creating large numerical  arrays  in  computer
  1046.          programs is very easy when you can produce vertical columns  of
  1047.          curly brackets or commas by the touch of one key.
  1048.  
  1049.       THE POSITION STACK. While writing somewhere in a  text,  it  often
  1050.          happens that you remember something you  should  add  somewhere
  1051.          else. The natural thing to do is press Alternate P,  go  there,
  1052.          make your changes,  ask  yourself  'What  was  I  doing  before
  1053.          this?', fail to remember what you were doing, in total despair,
  1054.          try Control P and simply continue your work.
  1055.  
  1056.       SECOND TEXT BUFFER. A peace of text you want to remove temporarily
  1057.          but not directly use again is pretty  safe  in  the  background
  1058.          text buffer. (See EDIT MENU, SWAP BUFFERS).
  1059.  
  1060.       THE PREDEFINED KEY MACROS Shift Control Arrow Up/Down can be  used
  1061.          to smoothly scroll through  a  text  using  the  keyboard:  the
  1062.          combination Control LeftShift Alternate breaks  the  key  macro
  1063.          output. Learn the following trick: Push down Control and  Shift
  1064.          with two fingers while holding your thumb on the Alternate key.
  1065.          Now press cursor down Edith starts walking down. When you  want
  1066.          to stop scrolling, simply press alternate with your  positioned
  1067.          thumb.
  1068.  
  1069.  
  1070. MISCELLANEOUS REMARKS
  1071.  
  1072.    1. PROPORTIONAL DISPLAY MODE you might have the impression  that  the
  1073.       cursor 'jumps over a tabulator'. This is OK. It happens  when  you
  1074.       type many thin characters ('i', 'l'); the  number  of  characters,
  1075.       not their width, determines which tab is taken.
  1076.  
  1077.       When a character occurs that is NOT in the selected character set,
  1078.       it will appear as a question mark, and the rest of the  text  line
  1079.       is not displayed properly. (Garbage; this is because of  different
  1080.       behaviour of the VDI functions v_gtext and vqt_extent).
  1081.  
  1082.    2. MAXIMUM LINE LENGTH. Although the maximum accepted length of lines
  1083.       is unbounded, there is a maximum visible column; in addition,  all
  1084.       text actions are limited to this maximum visible line length. (See
  1085.       NUMERICAL SPECIFICATIONS).
  1086.  
  1087.    3. TEXT MANIPULATIONS as found in the  'manipulation  group'  of  the
  1088.       'Text' menu, work at the maximum line length as specified  in  the
  1089.       section NUMERICAL SPECIFICATIONS. All these  functions  will  have
  1090.       the effect of cutting the line length down to the 'maximum visible
  1091.       line length'.
  1092.  
  1093.    4. UNDO actions involving lines that are longer than the visible line
  1094.       length are generally not  supported  (subject  to  change  in  the
  1095.       professional versions).
  1096.  
  1097.  
  1098. GEMINI
  1099.  
  1100.    Edith supports  parts  of  the  GEMINI  protocol.  In  practice,  the
  1101.    following is possible: install an Edith icon on the  GEMINI  desktop.
  1102.    Clicking on the icon opens Edith; dragging icons to  the  Edith  icon
  1103.    opens those files as texts. Dragging a folder on it  opens  the  file
  1104.    selector with folder. Dragging items onto a text window  inserts  the
  1105.    texts as text blocks. Dragging an icon onto the Edith control  window
  1106.    opens a new text. The exchange protocol for unused keys is  supported
  1107.    in two directions. (One of which is used depending of  whether  Edith
  1108.    is running as application or   accessory).   On   the   other   hand,
  1109.    PROTOSTATUS, PROTOKOLL and SETSTATUS things are NOT used. Accessories
  1110.    may therefore not recognize Edith as a  program  that  accepts  their
  1111.    messages.
  1112.  
  1113.    To load a text from the  Mupfel  console  window  use  OPEN.TTP  (See
  1114.    OPENING A TEXT)
  1115.  
  1116. ------------------------------------------------------------------------
  1117.  
  1118.  
  1119. APPENDIX. NUMERICAL SPECIFICATIONS
  1120.  
  1121.    The following specifications are independent of the overall design of
  1122.    Edith and are thus subject to changes in later versions.
  1123.  
  1124.    Number of texts.......................................5
  1125.    Maximum (visible) line length.......................160
  1126.    Maximum supported line length.................unbounded
  1127.    Maximum number of lines per text..................32000
  1128.    Maximum useable number of fonts......................40
  1129.    Maximum number of sizes supported per font...........20
  1130.    Number of text positions on stack.....................4
  1131.    Number of text blocks in selection, per text.....99/100  (1) (2)
  1132.    Maximum number of key macros.........................16  (2)
  1133.    Maximum length of macro key sequence.................79
  1134.    Number of tab markers................................80
  1135.  
  1136.    (1) 100 selections only after use of 'Invert Selection'.
  1137.  
  1138.    (2) These values will be unbounded in the commercial  version  'Edith
  1139.        Professional'.
  1140.  
  1141.